home *** CD-ROM | disk | FTP | other *** search
Amiga HyperGuide | 1997-03-31 | 23.2 KB | 703 lines |
- @hyperguide HyperText.hguide
- @$VER: HyperText.hguide 40.14 (30.03.97)
- @macro m_prg "@{b}HyperText DataType@{ub}"
- @macro m_template "Template : $1@{line}@{line}"
- @macro m_sscr "@{smallfont}$1@{deffont}"
- @include htds.hgm
-
- @node main "HyperText Dataype Documentation"
- @toc HTDS.hguide/main
- @prev HTDS.hguide/main
- @next hyperguide.hguide/main
-
- @{jcenter}@{m_title}@{m_copyright}@{m_welcome}@{jleft}
-
- @{settabs 30}
- @{m_sec Menu}
- @{m_menuitem}@{" Configuration " link Configuration }@{m_menuinfo "Adaption to your system"}
- @{m_menuitem}@{" Node indexing " link NodeIndexing }@{m_menuinfo "speeds up document opening"}
- @{m_menuitem}@{" Color expressions " link ColorExpressions}@{m_menuinfo "how to define new colors"}
- @{m_menuitem}@{" User Interface " link UserIFace }@{m_menuinfo "buttons, key-bindings and requesters"}
- @{m_menuitem}@{" ARexx Interface " link ARexxIFace }@{m_menuinfo "known ARexx commands"}
- @{m_menuitem}@{" Common Attributes " link CommonAttrs }@{m_menuinfo "HyperGuide Attributes"}
- @{m_menuitem}@{" XRef Interface " link XRefIFace }@{m_menuinfo "Cross-Reference Interface"}
- @{m_menuitem}@{" Dynamic Nodes " link DynamicNodes }@{m_menuinfo "Dynamic Nodes Interface"}
- @{m_menuitem}@{" Sub Datatypes " link HTDS.hguide/SubDataTypes}@{m_menuinfo "available sub datatypes"}
-
- @{m_menuitem}@{" Copyright " link HTDS.hguide/Copyright }@{m_menuinfo "legal stuff"}
- @{m_menuitem}@{" Author " link SR.hguide/Addresses }@{m_menuinfo "how to contact ..."}
- @{m_menuitem}@{" Registration " link HTDS.hguide/Registration}@{m_menuinfo "It's Shareware !!!"}
- @{m_endsec}
-
- @endnode
- @node Configuration "HyperText/Configuration"
-
- @{m_sec Configuration}
- As the recommended standard for datatypes, the preference file for the
- hypertext.datatype is called @{m_file hypertext.prefs} and is searched first in
- the @{m_file PROGDIR:Prefs/DataTypes} and then in @{m_file Env:DataTypes} directory.
- The following options are currently available using @{"ReadArgs()" link "dos/ReadArgs()"}
- argument parsing with the following templates. Each template is introduced with a
- prefix. This prefix has to be the very first in a line :
-
- @{itemize}
- @{item}@{m_cfgpre PATH}PATH/M/A
- @{definition}
- @{defterm}PATH
- @{defdata}Specifies the directories, which should be used for searching for any
- documents or embedded objects. Same as AmigaGuide PATH environment
- variable.
- @{enddefinition}
- @{item}@{m_cfgpre KEYFILE}KEYFILE/A
- @{definition}
- @{defterm}KEYFILE
- @{defdata}Specifies the full path of the HTDS keyfile. This keyfile is needed
- to use HTDS without restrictions. See @{" Registration " Link HTDS.hguide/Registration}.
- @{enddefinition}
- @{item}@{m_cfgpre GLOBAL}SHOWLINK/S,GLOBALTOC/S,ENDLESSTABCYCLE/S,SECURE/S,REXXSUFFIX/K,
- LISTINDENT/N/K,NODEINDEXING/S
- @{definition}
- @{defterm}SHOWLINK
- @{defdata}If this option is set, the link address will be shown in the window title,
- if the user press down the link button. So the user can check, where the link
- point to it, before following the link.@{line}
- This feature is implemented for the upcoming html.datatype subclass. I know
- that almost all Web-Browser show the linked address just by moving the mouse
- over the link. But this behaviour can't be implemented due to the fact BOOPSI
- handle input events. Any BOOPSI gadget must be active to get input events, but
- activation of a BOOPSI gadget is subject of the application, which uses the
- BOOPSI gadget (MultiView).
-
- @{defterm}GLOBALTOC
- @{defdata}If this option is set then any HyperText object, which hasn't a Table
- of Contents entry, the contents button is set to the @{m_file HTDS_TOC.hguide}
- document in the directory @{m_file "Help:<language>"}.@{line}
- You can use the provided ARexx script @{m_sample AddTOCEntry.rexx} to add the
- object currently displayed in MultiView to this global table of contents.
-
- @{defterm}ENDLESSTABCYCLE
- @{defdata}If this option is set, tabcycle is endless. That means, if the last
- link is active and you cycle forward, the first link is activated and vice
- versa.
-
- @{defterm}SECURE
- @{defdata}If this option is set, you cannot start any program or ARexx script
- from a link.
-
- @{defterm}REXXSUFFIX
- @{defdata}This option is for compatibility with AmigaGuide. The amigaguide.datatype
- uses a suffix of @{m_sample guide}, where the @{hyperguide} uses normal
- @{m_sample rexx} suffix. So if you want AmigaGuide compatibility set this
- option to @{m_sample guide}.
-
- @{defterm}LISTINDENT
- @{defdata}Specifies the default number aof spaces to indent any list related
- indention.
-
- @{defterm}NODEINDEXING
- @{defdata}Enables @{"node indexing" link NodeIndexing} for subdatatypes, which
- supports multiple nodes within one document/file. Currently only the @{hyperguide}
- datatype supports this.
- @{enddefinition}
- @{item}@{m_cfgpre BACKGROUND}DISABLEBGPIC/S,DEFBGPIC/K,DEFBGPEN/N/K,DEFFGPEN/N/K,DEFALTFGPEN/N/K,
- DEFBGCOLOR/K,DEFFGCOLOR/K,DEFALTFGCOLOR/K
- @{definition}
- @{defterm}DISBALEPIC
- @{defdata}disables any background picture. If you don't want background picture
- even for documents you haven't the control turn this option on.
-
- @{defterm}DEFBGPIC
- @{defdata}specifies a default background picture for all hypertext objects.
-
- @{defterm}DEFBGPEN
- @{defdata}specifies a default background pen for all hypertext objects.
-
- @{defterm}DEFFGPEN
- @{defdata}specifies a default foreground (text) pen for all hypertext objects.
-
- @{defterm}DEFALTFGPEN
- @{defdata}specifies a default alternate foreground (text) pen for all hypertext
- objects. This pen is used for foreground, if the foreground pen equals to the
- background pen.
-
- @{defterm}DEFBGCOLOR
- @{defdata}same as @{m_sample DEFBGPEN} except you can specify a @{"color expression" link ColorExpressions}.
-
- @{defterm}DEFFGCOLOR
- @{defdata}same as @{m_sample DEFFGPEN} except you can specify a @{"color expression" link ColorExpressions}.
-
- @{defterm}DEFALTFGCOLOR
- @{defdata}same as @{m_sample DEFALTFGPEN} except you can specify a @{"color expression" link ColorExpressions}.
- @{enddefinition}
- @{enditemize}
- @{m_endsec}
-
- @{m_sec "See Also"}
- @{" Node Indexing " link NodeIndexing}, @{" Color Expressions " link ColorExpressions}
- @{m_endsec}
- @endnode
- @node NodeIndexing "HyperText/Node Indexing"
-
- @{m_sec "Node Indexing"}
- The node indexing facility is used to create a list of internal nodes within
- a document (file) without scanning the hole document. Thus the opening of a
- document speeds up significant.
-
-
- If a document is open the first time, the datatype scans the hole document
- and creates a list of internal nodes. With node indexing turned on, the
- datatype saves all needed information in the tooltype field of the appropriate
- icon. So if the document is opened a second time it tries to load the node
- information from the icon.
-
-
- But the information isn't correct if the document meanwhile changed. In this
- situation the HyperText datatype checks the date stamps for the icon and the
- real document and if the document is newer it scans the document as it is
- opened the first time. So node indexing is absolutly transparent for document
- writers, if you have a working realtime clock.
-
-
- For example the gcc.guide (about 1.2 MB large) took about 9 secs for opening
- without node indexing on my system. With node indexing it tooks under 1 sec.
- @{m_endsec}
-
- @{m_sec "See Also"}
- @{" Configuration " link Configuration}
- @{m_endsec}
- @endnode
- @node ColorExpressions "HyperText/Color expressions"
-
- @{m_sec "Color expressions"}
- The hypertext.datatype provides a interface to obtain a specific color.
- The color can be a predefined color name or a RGB value string.
- The RGB value string is specified in the HTML form : @{m_sample "#RRGGBB"}, where
- @{m_sample RR} is the red , @{m_sample GG} is the green and @{m_sample BB} is the
- blue portion of the RGB value specified in hexdecimal digits. For example the
- @{m_sample "#FF0000"} and @{m_sample "Red"} color expressions gets the same color :
- Red.
-
-
- Here is the table of all predefined color names :
-
- @{settabs 20}@{code}
- @{fg highlight}Name@{tab}Color@{fg text}
-
-
- Black @{tab}#000000
- Green @{tab}#008000
- Silver @{tab}#C0C0C0
- Lime @{tab}#00FF00
- Gray @{tab}#808080
- Olive @{tab}#808000
- White @{tab}#FFFFFF
- Yellow @{tab}#FFFF00
- Maroon @{tab}#800000
- Navy @{tab}#000080
- Red @{tab}#FF0000
- Blue @{tab}#0000FF
- Purple @{tab}#800080
- Teal @{tab}#008080
- Fuchsia@{tab}#FF00FF
- Aqua @{tab}#00FFFF
- @{cleartabs}@{body}
- @{m_endsec}
- @endnode
-
- @node UserIFace "HyperText/User Interface"
-
- @{m_sec "User Interface"}
- The User Interface splits into three parts :
-
- @{m_sub "Buttons"}@{line}
- @{" Navigator Buttons " link UserIFace_Navigator}
-
- @{m_sub "Key-bindings"}@{line}
- Key-bindings can be used with a new DataType method. The application you use to
- browse must understand this new method.@{line}
- @{m_bold "Note:"} This is currently under construction.
-
- @{m_sub "Requesters"}@{line}
- There should be one or more requesters to interact with the HyperText object.
- Currently there is only one :
- @{itemize}
- @{item} @{" About Requester " link UserIFace_AboutRequester}
- @{item} @{" Search Requester " link UserIFace_SearchRequester}
- @{enditemize}
- @{m_endsec}
- @endnode
- @node UserIFace_Navigator "HyperText/User Interface/Navigator Buttons"
-
- @{m_sec "Navigator Buttons"}
- The following buttons are available :
- @{definition}
- @{defterm}Contents
- @{defdata}Is used to go to the table of contents node of the actual node.
-
- @{defterm}Index
- @{defdata}Is used to go to the index node of the actual node.
-
- @{defterm}Help
- @{defdata}Is used to go to the help node of the actual node.
-
- @{defterm}Retrace
- @{defdata}Is used to go downwards in the history list.
-
- @{defterm}Forward
- @{defdata}Is used to go upwards in the history list.
-
- @{defterm}Browse <
- @{defdata}Is used to go to the logical previous node of the actual node.
-
- @{defterm}Browse >
- @{defdata}Is used to go to the logical next node of the actual node.
-
- @{defterm}@{"Search"link UserIFace_SearchRequester} @{m_regonly}
- @{defdata}
-
- @{defterm}@{"About" link UserIFace_AboutRequester}
- @{defdata}
- @{m_endsec}
-
- @{m_sec "Configuration"}
- From version 40.7 the navigator buttons are configureable. You can define
- your own favorite button row. This is done by creating a ASCII file and
- write a line for each button. Lines beginning with a semicolon are skipped.
- The line is parsed using the following ReadArgs() template : "TEXT/A,COMMAND/A/F".
- The TEXT argument specifies the text which should displayed. The COMMAND argument
- specifies an @{"ARexx command" link ARexxIFace} of the hypertext.datatype.
-
-
- For each hypertext object the hypertext.datatype tries to open such a file in
- the specified order :
-
- @{enumerate}
- @{item}PROGDIR:Prefs/DataTypes/HyperText/<datatypename>.Buttons
- @{item}PROGDIR:Prefs/DataTypes/HyperText/Default.Buttons
- @{item}Env:DataTypes/HyperText/<datatypename>.Buttons
- @{item}Env:DataTypes/HyperText/Default.Buttons
- @{endenumerate}
-
- @{m_sub "Example"}
- @{separator}@{code};
- ; this file defines a contents and AddTOCEntry button
- ;
- Contents @{"CONTENTS" link ARexxIFace_CONTENTS}
- Add2TOC @{"RX" link ARexxIFace_RX} HTDS:ARexx/AddTOCEntry.rexx
- @{separator}@{body}
-
- This navigator button configuration scheme is only available in the registered version.
- @{m_endsec}
- @endnode
- @node UserIFace_AboutRequester "HyperText/User Interface/About Requester"
-
- @{m_sec "About Requester"}
- The About Requester display version and copyright information about the HTDS.
- @{line}@{line}@{separator}@{line}
- It displays also the following information about the current viewed document (object) :
- @{itemize}
- @{item} Name
- @{item} Version
- @{item} Author
- @{item} Copyright
- @{item} Annotation
- @{enditemize}
-
- @{m_bold "Note"}@{line}
- If you want to support this feature with your own datatype. Just set the DTA_Obj#?
- attributes.
- @{m_endsec}
- @endnode
- @node UserIFace_SearchRequester "HyperText/User Interface/Search Requester"
-
- @{m_sec "Search Requester"}
- The following search requester enables you to search strings and patterns
- in a hypertext document. The search is only line orientated. This means it matches
- a string exactly one time per line regardless of the number the string occured in
- the line :
-
- @{line}@{line}@{jcenter}@{object /pics/SearchWin.png}@{jleft}@{line}@{line}
-
- As you can see there are 4 checkbox gadgets, one string gadget and 2 button gadgets :
-
- @{definition}
- @{defterm}`Pattern' checkbox :
- @{defdata}If checked the string is interpreted as a pattern
-
- @{defterm}`Ignore Case' checkbox :
- @{defdata}If checked the search is case insensitve
-
- @{defterm}`Backward search' checkbox :
- @{defdata}Currently not implemented and therefore disabled. But if this is checked
- the search will be backward.
-
- @{defterm}`Search all nodes' checkbox :
- @{defdata}Currently not implemented and therefore disabled. But if this is checked
- the search will be done in all nodes of the current document. For example
- this should search all 'physical' nodes in a @{hyperguide} document and
- create a dynamic hypertext page, which consist out of links to all
- search results.
-
- @{defterm}`String' gadget :
- @{defdata}Here you can type your string or pattern. If you hit return it will invoke
- the search routine. So just by hitting return you can step through the next
- occurance of your string or pattern.
-
- @{defterm}`Search' button :
- @{defdata}Invokes the search routine and quits the search requester.
-
- @{defterm}`Cancel' button :
- @{defdata}cancels the search requester.
- @{enddefinition}
-
- The shortcuts for each gadget is reached from the string gadget by pressing left amiga
- key and the appropriate shortcut letter.
- @{m_endsec}
- @endnode
-
- @node ARexxIFace "HyperText/ARexx Interface"
-
- @{m_sec "ARexx Interface"}
- The @{m_prg} provides a own ARexx port for each hypertext.datatype object.
- It's name is the port name passed via DTA_ARexxPortName plus a
- suffix of '.1' or if this port exists '.2' and so on.
- For example if you start MultiView with a hypertext object, MultiView
- passes "MULTIVIEW.1" for DTA_ARexxPortName to the hypertext object.
- The hypertext object tries to open a port named "MULTIVIEW.1.1".
-
-
-
- The following ARexx Commands are available :
-
-
- @{settabs 20 40 60 80 100 120}
- @{" ABOUT " link ARexxIFace_ABOUT}@{tab}
- @{" BACK " link ARexxIFace_RETRACE}@{tab}
- @{" BEEP " link ARexxIFace_BEEP}@{tab}
- @{" CLOSE " link ARexxIFace_CLOSE}@{tab}
- @{" CONTENTS " link ARexxIFace_CONTENTS}@{tab}
- @{" EXPORT " link ARexxIFace_EXPORT} *@{tab}
- @{" FLUSH " link ARexxIFace_FLUSH}@{tab}
- @{" FORWARD " link ARexxIFace_FORWARD}@{tab}
- @{" GETATTR " link ARexxIFace_GETATTR}@{tab}
- @{" SETATTR " link ARexxIFace_SETATTR}@{tab}
- @{" HELP " link ARexxIFace_HELP}@{tab}
- @{" INDEX " link ARexxIFace_INDEX}@{tab}
- @{" LINK " link ARexxIFace_LINK}@{tab}
- @{" NEXT " link ARexxIFace_NEXT}@{tab}
- @{" NEXTINTERNAL " link ARexxIFace_NEXTINTERNAL}@{tab}
- @{" PREVIOUS " link ARexxIFace_PREVIOUS}@{tab}
- @{" QUIT " link ARexxIFace_CLOSE}@{tab}
- @{" RETRACE " link ARexxIFace_RETRACE}@{tab}
- @{" RX " link ARexxIFace_RX} *@{tab}
- @{" SEARCH " link ARexxIFace_SEARCH} *@{tab}
- @{cleartabs}
-
-
- Note: '*' marked commands are only available in the registered version.
- @{m_endsec}
-
- @endnode
- @node ARexxIFace_ABOUT "HyperText/ARexx Interface/ABOUT"
-
- @{m_sec ABOUT}
- @{m_template "none"}
- The ABOUT command opens the @{"about" link UserIFace_AboutRequester} requester.
- @{m_endsec}
- @endnode
- @node ARexxIFace_BEEP "HyperText/ARexx Interface/BEEP"
-
- @{m_sec BEEP}
- @{m_template "none"}
- The BEEP command performs a intuition DisplayBeep().
- @{m_endsec}
- @endnode
- @node ARexxIFace_CLOSE "HyperText/ARexx Interface/CLOSE, QUIT"
-
- @{m_sec "CLOSE, QUIT"}
- @{m_template "none"}
- These commands tries to quit the application of the datatype by sending
- it a `break c' signal.
- @{m_endsec}
- @endnode
- @node ARexxIFace_RETRACE "HyperText/ARexx Interface/RETRACE, BACK"
-
- @{m_sec "RETRACE, BACK"}
- @{m_template "none"}
- These commands are used to go back to the last view'd node.
- @{m_endsec}
- @endnode
- @node ARexxIFace_FORWARD "HyperText/ARexx Interface/FORWARD"
-
- @{m_sec "FORWARD"}
- @{m_template "none"}
- The command is used to go to the next viewed node of the actual node.
- @{m_endsec}
- @endnode
- @node ARexxIFace_GETATTR "HyperText/ARexx Interface/GETATTR"
-
- @{m_sec "GETATTR"}
- @{m_template "OBJECT/A,NAME,FIELD,STEM/K,VAR/K"}
- This command is used to retrieve information from the HyperText-DataType-System
- or HyperText object. The following object types are available :
-
- @{itemize}
- @{item}OBJECT@{line}
- Obtain information from the HyperText object. Currently the following fields
- are available :
- @{definition}
- @{defterm}TITLE
- @{defdata}objects current title.
-
- @{defterm}PATH
- @{defdata}objects current full file path including node name
-
- @{defterm}NODENAME
- @{defdata}objects current node name if any
-
- @{defterm}AUTHOR
- @{defdata}object's author
-
- @{defterm}COPYRIGHT
- @{defdata}object's copyright notice
-
- @{defterm}ANNOTATION
- @{defdata}object's annotation
-
- @{defterm}VERSION
- @{defdata}object's version
-
- @{defterm}TOPVERT
- @{defdata}object's vertical top value (DTA_TopVert)
-
- @{defterm}TOPHORIZ
- @{defdata}object's horizontal top value (DTA_TopHoriz)
-
- @{defterm}TOTALVERT
- @{defdata}object's total vertical value (DTA_TotalVert)
-
- @{defterm}TOTALHORIZ
- @{defdata}object's total horizontal value (DTA_TotalHoriz)
-
- @{defterm}VISIBLEVERT
- @{defdata}object's visible vertical value (DTA_VisibleVert)
-
- @{defterm}VISIBLEHORIZ
- @{defdata}object's visible horizontal value (DTA_VisibleHoriz)
-
- @{defterm}VERTUNIT
- @{defdata}object's vertical unit value (DTA_VertUnit)
-
- @{defterm}HORIZUNIT
- @{defdata}object's horizontal value (DTA_HorizValue)
-
- @{defterm}BUFFER @{m_sscr *}
- @{defdata}object's raw buffer, containing raw HTML or @{hyperguide} code.
-
- @{defterm}STATUS @{m_sscr *}
- @{defdata}current status of the object (OK or LAYOUT)
-
- @{enddefinition}
- @{item}APPLICATION@{line}
- Obtain information from the HyperText environment. Currently the following fields
- are available :
- @{definition}
- @{defterm}VERSION @{m_sscr *}
- @{defdata}version of the HyperText-Datatype-System
-
- @{defterm}SCREEN @{m_sscr *}
- @{defdata}public screen name the current object resides in
- @{enddefinition}
- @{fg high}@{m_sscr *}@{fg text} These fields aren't available in the STEM array.
- @{enditemize}
- @{m_endsec}
-
- @{m_sec "Example"}
- @{separator}@{code}
- 'GETATTR OBJECT=APPLICATION FIELD=SCREEN VAR=SCREEN'
- 'GETATTR OBJECT=OBJECT STEM=HTDS'
-
-
- Say 'PubScreen : ' || screen
- Say 'ObjAuthor : ' || htds.object.author
- Say 'ObjVersion: ' || htds.object.version
- @{separator}@{body}
- @{m_endsec}
-
- @{m_sec "See Also"}
- @{" SETATTR " link ARexxIFace_SETATTR}, Amiga User Interface Style Guide - ARexx chapter
- @{m_endsec}
- @endnode
- @node ARexxIFace_SETATTR "HyperText/ARexx Interface/SETATTR"
-
- @{m_sec "SETATTR"}
- @{m_template "OBJECT/A,NAME,FIELD,STEM/K,VAR/K"}
- This command is used to set attributes of a HyperText object. The following object
- types are available :
-
- @{itemize}
- @{item}OBJECT@{line}
- Set attributes of a HyperText object. Currently the following fields
- are available :
- @{definition}
- @{defterm}TITLE
- @{defdata}object's current title.
-
- @{defterm}TOPVERT
- @{defdata}object's vertical top value (DTA_TopVert)
-
- @{defterm}TOPHORIZ
- @{defdata}object's horizontal top value (DTA_TopHoriz)
- @{enddefinition}
- @{fg high}@{m_sscr *}@{fg text} These fields aren't available in the STEM array.
- @{enditemize}
- @{m_endsec}
-
- @{m_sec "Example"}
- @{separator}@{code}
- title = 'My objects title'
- 'SETATTR OBJECT=OBJECT FIELD=TITLE VAR=TITLE'
- @{separator}@{body}
- @{m_endsec}
-
- @{m_sec "See Also"}
- @{" GETATTR " link ARexxIFace_GETATTR}, Amiga User Interface Style Guide - ARexx chapter
- @{m_endsec}
- @endnode
- @node ARexxIFace_PREVIOUS "HyperText/ARexx Interface/PREVIOUS"
-
- @{m_sec "PREVIOUS"}
- @{m_template "none"}
- The command is used to go to the previous node in the document. Same
- as "Browse <" button.
- @{m_endsec}
- @endnode
- @node ARexxIFace_NEXT "HyperText/ARexx Interface/NEXT"
-
- @{m_sec "NEXT"}
- @{m_template "none"}
- The command is used to go to the next node in the document. Same
- as "Browse >" button.
- @{m_endsec}
- @endnode
- @node ARexxIFace_LINK "HyperText/ARexx Interface/LINK"
-
- @{m_sec "LINK"}
- @{m_template "OBJECT"}
- The command is used to go to the document named with the OBJECT argument.
- @{m_endsec}
- @endnode
- @node ARexxIFace_HELP "HyperText/ARexx Interface/HELP"
-
- @{m_sec "HELP"}
- @{m_template "none"}
- The command is used to go to the help document of the actual node. Same
- as "Help" button.
- @{m_endsec}
- @endnode
- @node ARexxIFace_INDEX "HyperText/ARexx Interface/INDEX"
-
- @{m_sec "INDEX"}
- @{m_template "none"}
- The command is used to go to the index document of the actual node. Same
- as "Index" button.
- @{m_endsec}
- @endnode
- @node ARexxIFace_CONTENTS "HyperText/ARexx Interface/CONTENTS"
-
- @{m_sec "CONTENTS"}
- @{m_template "none"}
- The command is used to go to the contents document of the actual node. Same
- as "Contents" button.
- @{m_endsec}
- @endnode
- @node ARexxIFace_SEARCH "HyperText/ARexx Interface/SEARCH"
-
- @{m_sec "SEARCH"}
- @{m_template "STRING/K,PATTERN/S,NOCASE/S,PROMPT/S"}
- The command is used to search for a given string or pattern within the current
- node.
- With the STRING argument you can specify the string or pattern to search for.
- The PATTERN switch enables AmigaOS pattern search. NOCASE makes the search
- case insensitive. The PROMPT switch is used to open the @{"search requester" link UserIFace_SearchRequester}.
- @{m_endsec}
-
- @{m_sec "NOTE"}
- This command is only available in the registered version.
- @{m_endsec}
- @endnode
- @node ARexxIFace_FLUSH "HyperText/ARexx Interface/FLUSH"
-
- @{m_sec "FLUSH"}
- @{m_template "DOCUMENT/K"}
- This command is used to flush a document from the hypertext document cache.
- Its sometimes neccessary to do that, because any opened document is locked
- by the datatypes.library.
- @{m_endsec}
- @endnode
- @node ARexxIFace_RX "HyperText/ARexx Interface/RX"
-
- @{m_sec "RX"}
- @{m_template "COMMAND/F"}
- The command is used to start a ARexx script. The COMMAND argument specifies the script.
- @{m_endsec}
-
- @{m_sec "NOTE"}
- This command is only available in the registered version.
- @{m_endsec}
- @endnode
- @node ARexxIFace_EXPORT "HyperText/ARexx Interface/EXPORT"
-
- @{m_sec EXPORT}
- @{m_template "FILE,CLIP/S,CLIPUNIT/N/K,TYPE/K,ARGS/F"}
- The EXPORT command is used to export the contents of the current node
- into a file or the clipboard. The TYPE argument may specify which format
- should be used. The appropriate export class has to exist in the
- @{m_file "Sys:Classes/HyperText/Export"} directory.
-
-
- @{m_sec "NOTE"}
- This command is only available in the registered version.
- @{m_endsec}
- @endnode
- @node ARexxIFace_NEXTINTERNAL "HyperText/ARexx Interface/NEXTINTERNAL"
-
- @{m_sec NEXTINTERNAL}
- @{m_template "none"}
- This command is used to go to the next internal (physical) node within a
- document. So you can step through the nodes of an @{hyperguide} document
- in the order they appeared in the file.
- @{m_endsec}
- @endnode
-
- @node CommonAttrs "HyperText/HyperGuide Attributes"
-
- @{m_sec "HyperGuide Attributes"}
- The hypertext.datatype provides some functions to parse basic @{hyperguide}
- attributes such like text style and color attributes.
- The idea behind that is, that any subdatatype of the hypertext.datatype
- can use these attributes. The @{"directory.datatype" link directory.hguide/main} and the @{"man.datatype" link man.hguide/main}
- are examples for that. The following attributes can be used for these datatypes:
-
- @{itemize}
- @{item}@{" Text Style " link hyperguide.hguide/ATTRS_TEXTSTYLE}
- @{item}@{" Text Font " link hyperguide.hguide/ATTRS_TEXTFONT}
- @{item}@{" Text Color " link hyperguide.hguide/ATTRS_TEXTCOLOR}
- @{item}@{" Justification " link hyperguide.hguide/ATTRS_JUSTIFICATION}
- @{enditemize}
- @{m_endsec}
- @endnode
- @node XRefIFace "HyperText/XRef Interface"
-
- @{m_sec "Cross-Reference Interface"}
- @{m_niy}
- @{m_endsec}
- @endnode
- @node DynamicNodes "HyperText/Dynamic Nodes"
-
- @{m_sec "Dynamic Nodes"}
- @{m_niy}
- @{m_endsec}
- @endnode
-
-